# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Scorpion Swamp Template

game: Scorpion Swamp
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Scorpion Swamp: 1.0.1 # Version of the world required for this yaml to work as expected.

Scorpion Swamp:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ################
  # Goal Options #
  ################
  goal:
    # The goal of the run.
    # 
    # Selator/Poomchukker/Grimslade - Complete this quest in the game to win.
    # 
    # Any - Any of the quests can be completed to win.
    # 
    # All - All the quests must be separately completed to win.
    any: 50
    selator: 0
    poomchukker: 0
    grimslade: 0
    all: 0

  required_amulets:
    # Makes Grimslade's quest require this many Amulets to be completed.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 5
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-5: 0 # random value between 0 and 5
    vanilla: 50 # equivalent to -1

  ####################
  # Location Options #
  ####################
  clearingsanity:
    # Makes entering every clearing for the first time a location and adds items named "Clearing x" to
    # the item pool where x is the clearing's number. These new items will be needed to access their respective
    # clearing in the first place.
    'false': 50
    'true': 0

  spellsanity:
    # Adds all the places in the game where you can get Spell Gems as new locations and shuffles the
    # vanilla Spell Gems into the item pool.
    'false': 50
    'true': 0

  wizardsanity:
    # Adds the three wizards to the item pool. You will always start with one of them. Three locations will be added
    # where you get directions to where the wizards live.
    'false': 50
    'true': 0

  extra_locations:
    # Adds additional locations for reaching all the bad endings in the game aside from running out of Stamina.
    # 
    # If Progressive Statistics is on, this will be forced on as well.
    'false': 50
    'true': 0

  ################
  # Item Options #
  ################
  progressive_stats:
    # Adds additional items to the item pool that increase the minimum values of each of your stats at the beginning
    # of each run. For example, if you have three Progressive Skill items your Skill will be in the range of 10-12
    # instead of 7-12.
    # 
    # If this setting is on, Extra Locations will be forced on as well regardless of your settings to accommodate the
    # additional items.
    'false': 50
    'true': 0

  filler_weights:
    # For any filler items that are added, these are the weights that each choice will be added. Any of the game's items
    # can be added to this list if desired. Leave it as the default if you don't know what you're doing.
    # 
    # If all weights are 0, the filler items will all be Stamina Spell Gems.
    Luck Spell Gem: 1
    Skill Spell Gem: 1
    Stamina Spell Gem: 1

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
